/*
 * Copyright (c) 2011-2012 Alexander Dubu
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * o  Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * o  Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * o  Neither the name Axil nor the names of its contributors may be used to
 *    endorse or promote products derived from this software without specific
 *    prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package axil.framework.resource;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.Reader;


/**
 * A facade wrapped around a Reader object so that a reference can be maintained.
 */
public class ReferenceReader extends BufferedReader {
	private String reference;
	private Reader reader;


	public ReferenceReader(String reference, Reader reader) {
		super(reader);
		this.reference = reference;
		this.reader = reader;
	}


	/**
	 * Get the diagnostic reference for this reader. The string returned tells
	 * the user where something went wrong.
	 */
	public String reference() {
		return reference;
	}


	/**
	 * Reads characters into a portion of an array.  This method will block
	 * until some input is available, an I/O error occurs, or the end of the
	 * stream is reached.
	 *
	 * @param	  cbuf  Destination buffer
	 * @param	  off   Offset at which to start storing characters
	 * @param	  len   Maximum number of characters to read
	 *
	 * @return The number of characters read, or -1 if the end of the
	 *             stream has been reached
	 *
	 * @exception java.io.IOException  If an I/O error occurs
	 */
	public int read(char[] cbuf, int off, int len) throws IOException {
		return reader.read(cbuf, off, len);
	}


	/**
	 * Closes the stream and releases any system resources associated with
	 * it.  Once the stream has been closed, further read(), ready(),
	 * mark(), reset(), or skip() invocations will throw an IOException.
	 * Closing a previously closed stream has no effect.
	 *
	 * @exception java.io.IOException  If an I/O error occurs
	 */
	public void close() throws IOException {
		reader.close();
	}
}
